home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_hylafax.idb / usr / freeware / var / httpd / cgi-bin / manpage.z / manpage
Encoding:
Korn shell script  |  1999-07-16  |  4.8 KB  |  129 lines
  1. #!/bin/ksh
  2. #    $Id: manpage.sh.in,v 1.20 1996/06/24 03:03:40 sam Rel $
  3. #
  4. # Copyright (c) 1994-1995 Sam Leffler
  5. # Copyright (c) 1994-1995 Silicon Graphics, Inc.
  6. # 
  7. # Permission to use, copy, modify, distribute, and sell this software and 
  8. # its documentation for any purpose is hereby granted without fee, provided
  9. # that (i) the above copyright notices and this permission notice appear in
  10. # all copies of the software and related documentation, and (ii) the names of
  11. # Sam Leffler and Silicon Graphics may not be used in any advertising or
  12. # publicity relating to the software without the specific, prior written
  13. # permission of Sam Leffler and Silicon Graphics.
  14. # 
  15. # THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  16. # EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  17. # WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  18. # 
  19. # IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  20. # ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  21. # OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  22. # WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  23. # LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  24. # OF THIS SOFTWARE.
  25. #
  26.  
  27. #
  28. # manpage?query
  29. #
  30. # Retrieve a UNIX manual page using man and return an HTML
  31. # document with the appropriate font changes and anchors
  32. # (for other manual page references).  Other stuff like page
  33. # headers and footers are left, though they could trivially
  34. # be removed with more sed commands.  Likewise one can add
  35. # other anchors such as include file references.
  36. #
  37. # Note that only a single manual page (the first hit) is
  38. # returned.  This is not a general purpose manual interface;
  39. # it's intended for linking manual pages to HTML documents.
  40. #
  41. # NB: man is much faster if invoked with a section; it's best
  42. #     to use "manpage?section+query" instead of "manpage?query"
  43. #
  44. PATH=/bin:/usr/bin
  45. test -d /usr/sbin && PATH=$PATH:/usr/sbin        # SGI and others
  46. test -d /usr/bsd && PATH=$PATH:/usr/bsd            # SGI
  47. test -d /usr/ucb && PATH=$PATH:/usr/ucb            # Sun and others
  48. test -d /usr/5bin && PATH=/usr/5bin:$PATH        # Sun and others
  49. test -d /usr/local/bin && PATH=/usr/local/bin:$PATH    # for GNU stuff
  50.  
  51. ECHO=/bin/echo
  52. SED=/bin/sed
  53. CAT=/bin/cat
  54. MAN=/bin/man
  55. COL=/bin/col
  56. MAN2HTML=/var/httpd/cgi-bin/man2html
  57.  
  58. case "mips-sgi-irix6.5-ALPHA-1275645130" in
  59. *-irix*)    MAN_FLAGS="-p -c" ;;
  60. *)        MAN_FLAGS="" ;;
  61. esac
  62.  
  63. #
  64. # XXX the server expands the pathname when
  65. # setting SCRIPT_NAME, so it can't be reused.
  66. #
  67. SCRIPT_NAME=/cgi-bin/manpage
  68. UNQUOTE=/var/httpd/cgi-bin/unquote
  69.  
  70. MANPATH=/usr/freeware/man:/usr/share/catman:/usr/share/man:/usr/catman:/usr/man
  71. export MANPATH
  72.  
  73. $ECHO 'Content-type: text/html'
  74. $ECHO ''
  75.  
  76. cvtLinks()
  77. {
  78.     #
  79.     # The first two expressions skip correctly formatted page headers
  80.     # (NB: many man pages are incorrectly formatted).  The 3rd
  81.     # expression handles the normal man page reference.  The
  82.     # last 3 expressions deal with incorrectly formatted references.
  83.     #
  84.     $SED -e "/^ *[A-Z][A-Z_0-9]*([l-p1-8][a-zA-Z]*)/n" \
  85.     -e "/^ *<B> *[A-Z][A-Z_0-9]*([l-p1-8][a-zA-Z]*)/n" \
  86.     -e "s;<[IB]>\([^<]*\)</[IB]>(\([l-p1-8]\)\([a-zA-Z]\{0,1\}\));<A HREF=\"$SCRIPT_NAME?\2+\1\">\1(\2\3)</A>;g" \
  87.     -e "s;<[IB]>\([^<]*\)</[IB]>(<[IB]>\([l-p1-8]\)\([a-zA-Z]\{0,1\}\)</[IB]>);<A HREF=\"$SCRIPT_NAME?\2+\1\">\1(\2\3)</A>;g" \
  88.     -e "s;<[IB]><[IB]>\([^<]*\)</[IB]></[IB]>(\([l-p1-8]\)\([a-zA-Z]\{0,1\}\));<A HREF=\"$SCRIPT_NAME?\2+\1\">\1(\2\3)</A>;g" \
  89.     -e "s;\([a-zA-Z_0-9][a-zA-Z_0-9]*\)(\([l-p1-8]\)\([a-zA-Z]\{0,1\}\));<A HREF=\"$SCRIPT_NAME?\2+\1\">\1(\2\3)</A>;g"
  90. }
  91.  
  92. QUERY=`$ECHO "$QUERY_STRING" | $UNQUOTE -qn`
  93.  
  94. $CAT<<EOF
  95. <TITLE>UNIX Manual Page: man $QUERY</TITLE>
  96.  
  97. <BODY>
  98. EOF
  99.  
  100. if [ -x $MAN -a -x $COL -a -x $MAN2HTML ]; then
  101.     CMD=`$MAN $MAN_FLAGS $QUERY | $SED 1q`
  102.     case "$CMD" in
  103.     *[nN]o*manual*)
  104.     echo "<H2><IMG SRC=\"/hylafax/icons/button.excl.gif\">$CMD</H2>"
  105.     echo 'The <KBD>man</KBD> command did not locate the requested manual'
  106.     echo 'page.  This is typically because the file is not present on the'
  107.     echo 'machine, but it can also be caused by a mistyped query string'
  108.     echo 'or some resource (e.g. an NFS-mounted filesystem) being'
  109.     echo 'temporarily unavailable.'
  110.     ;;
  111.     *)
  112.     echo '<PRE WIDTH=80>'
  113.     $MAN $MAN_FLAGS $QUERY 2>/dev/null | $COL -x | $MAN2HTML | cvtLinks
  114.     echo '</PRE>'
  115.     ;;
  116.     esac
  117. else
  118.     echo '<H2><IMG SRC="/hylafax/icons/button.excl.gif">No manual page support</H2>'
  119.     echo 'All the programs required to support manual page queries were'
  120.     echo 'not available or were not in the expected locations.  The following'
  121.     echo 'programs are required:'
  122.     echo '<PRE>'
  123.     echo "$MAN    standard manual page program"
  124.     echo "$COL    to filter reverse-line feeds"
  125.     echo "$MAN2HTML    to convert the output of $MAN to HTML"
  126.     echo '</PRE><P>'
  127. fi
  128. echo '</BODY>'
  129.